<!doctype html>
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta http-equiv="content-type" content="IE=edge,chrome=1" charset="utf-8" />
		<meta name="generator" content="JsDoc Toolkit" />
		
		<title>BE.comp</title>
        <link rel="stylesheet" href="../css/default.css" type="text/css" media="screen, projection">
	</head>

	<body>
<!-- ============================== header ================================= -->	
		<!-- begin static/header.html -->
		<div id="header">
</div>
		<!-- end static/header.html -->

<!-- ============================== classes index ============================ -->
		<div id="index">
			<!-- begin publish.classesIndex -->
			<div align="center"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<hr />
<h2>Classes</h2>
<ul class="classList">
	
	<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
	
	<li><a href="../symbols/Array.html">Array</a></li>
	
	<li><a href="../symbols/BE.html">BE</a></li>
	
	<li><a href="../symbols/BE.comp.html">BE.comp</a></li>
	
	<li><a href="../symbols/BE.ERROR.html">BE.ERROR</a></li>
	
	<li><a href="../symbols/BE.layer.html">BE.layer</a></li>
	
	<li><a href="../symbols/BE.log.html">BE.log</a></li>
	
	<li><a href="../symbols/BE.proj.html">BE.proj</a></li>
	
	<li><a href="../symbols/BE.time.html">BE.time</a></li>
	
	<li><a href="../symbols/BE.ui.html">BE.ui</a></li>
	
	<li><a href="../symbols/BE.ui.viewsConstructor.html">BE.ui.viewsConstructor</a></li>
	
	<li><a href="../symbols/BE.util.SettingsManager.html">BE.util.SettingsManager</a></li>
	
	<li><a href="../symbols/String.html">String</a></li>
	
</ul>
<hr />
			<!-- end publish.classesIndex -->
		</div>
		
		<div id="content">
<!-- ============================== class title ============================ -->
			<h1 class="classTitle">
				
				Namespace BE.comp
			</h1>

<!-- ============================== class summary ========================== -->			
			<p class="description">
				
				<br />Extends
					<a href="../symbols/BE.html">BE</a>.<br />
				
			
				
				
				
					<br /><i>Defined in: </i> <a href="../symbols/src/_Users_collinbrooks_Dropbox_Scripts_AEScripts_BeforeEffects_src_comp_comp.jsxinc.html">comp.jsxinc</a>.
				
			</p>

<!-- ============================== constructor summary ==================== -->			
			
			<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class BE.comp.">
				<caption>Namespace Summary</caption>
				<thead>
					<tr>
						<th scope="col">Constructor Attributes</th>
						<th scope="col">Constructor Name and Description</th>
					</tr>
				</thead>
				<tbody>
					<tr>
						<td class="attributes">&nbsp;</td>
						<td class="nameDescription" >
							<div class="fixedFont">
								<b><a href="../symbols/BE.comp.html#constructor">BE.comp</a></b>
							</div>
							<div class="description">Contains composition helper methods that provide more functionality than
the original AE API.</div>
						</td>
					</tr>
				</tbody>
			</table>
			

<!-- ============================== properties summary ===================== -->
			

<!-- ============================== methods summary ======================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class BE.comp.">
					<caption>Method Summary</caption>
					<thead>
						<tr>
							<th scope="col">Method Attributes</th>
							<th scope="col">Method Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">BE.comp.<b><a href="../symbols/BE.comp.html#.getAllSelectedProperties">getAllSelectedProperties</a></b>(c)
								</div>
								<div class="description">Goes through each layer within the given comp and builds an array of
references to all the selected properties within the comp.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">BE.comp.<b><a href="../symbols/BE.comp.html#.getFilteredLayers">getFilteredLayers</a></b>(c, f)
								</div>
								<div class="description">Returns an Array of the layers within a given composition optionally
filtering out certain types of layers.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">BE.comp.<b><a href="../symbols/BE.comp.html#.getLayerNames">getLayerNames</a></b>(c, f)
								</div>
								<div class="description">Returns an array of the layer names within a given composition optionally
filtering out certain types of layers.</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
				<dl class="inheritsList">
				
				</dl>
				
			
<!-- ============================== events summary ======================== -->
			

<!-- ============================== constructor details ==================== -->		
			
			<div class="details"><a name="constructor"> </a>
				<div class="sectionTitle">
					Namespace Detail
				</div>
				
				<div class="fixedFont">
						<b>BE.comp</b>
				</div>
				
				<div class="description">
					Contains composition helper methods that provide more functionality than
the original AE API.
					
				</div>
				
				
				
				
					
					
					
					
					
					
					
						<dl class="detailList">
						<dt class="heading">See:</dt>
						
							<dd><a href="../symbols/BE.html">BE</a></dd>
						
						</dl>
					

			</div>
			

<!-- ============================== field details ========================== -->		
			

<!-- ============================== method details ========================= -->		
			
				<div class="sectionTitle">
					Method Detail
				</div>
				
					<a name=".getAllSelectedProperties"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{Object[]|Bool}</span>
					<span class="light">BE.comp.</span><b>getAllSelectedProperties</b>(c)
					
					</div>
					<div class="description">
						Goes through each layer within the given comp and builds an array of
references to all the selected properties within the comp.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{CompItem}</span> <b>c</b>
									
								</dt>
								<dd>The composition to search.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Object[]|Bool}</span> False if no properties are selected, or an array
of object consisting of the following fields:

parent: The CompItem that the layer with this property is contained in.
layer: The Layer that this property belongs to.
selectedProperties: An array of the properties that are selected in
this layer.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".getFilteredLayers"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{Layer[]}</span>
					<span class="light">BE.comp.</span><b>getFilteredLayers</b>(c, f)
					
					</div>
					<div class="description">
						Returns an Array of the layers within a given composition optionally
filtering out certain types of layers.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{CompItem}</span> <b>c</b>
									
								</dt>
								<dd>The composition whose layers are to be returned</dd>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/String.html">String</a>[]}</span> <b>f</b>
									<i>Optional, Default: []</i>
								</dt>
								<dd>An array of strings representing the type of layer
to be included in the returned array. If not set, nothing is filtered.

Example: 'LightLayer', 'AVLayer', 'CameraLayer', 'ShapeLayer'</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Layer[]}</span> An array of the layers within the given comp.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".getLayerNames"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{<a href="../symbols/String.html">String</a>[]}</span>
					<span class="light">BE.comp.</span><b>getLayerNames</b>(c, f)
					
					</div>
					<div class="description">
						Returns an array of the layer names within a given composition optionally
filtering out certain types of layers.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{CompItem}</span> <b>c</b>
									
								</dt>
								<dd>The composition whose layer names are to be returned</dd>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/String.html">String</a>[]}</span> <b>f</b>
									<i>Optional</i>
								</dt>
								<dd>An array of strings representing the type of layer
to be included in the returned array. If not set, nothing is filtered.

Example: 'LightLayer', 'AVLayer', 'CameraLayer', 'ShapeLayer'</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{<a href="../symbols/String.html">String</a>[]}</span> An array of the names of the layers within the comp.</dd>
							
							</dl>
						
						
						

					
				
			
			
<!-- ============================== event details ========================= -->		
			
			
			<hr />
		</div>

		
<!-- ============================== footer ================================= -->
		<div class="fineprint" style="clear:both">
			&copy;2010<br />
			Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0 on Sun May 22 2011 22:54:53 GMT-0500 (CDT)
		</div>
	</body>
</html>
